package eitwitter.learning;

/**
 * Classe permettant de stocker les informations relatives à un mot
 * @author AH & PJ
 */
public class WordInformations {
	
	/** Nombre de documents ou le mot apparait */
	private int documentsNumber;
	
	/** Nombre de fois ou le document apparait */
	private int frequency;
	
	/** Beta du mot */
	private double beta;

	/**
	 * Constructeur des informations concernant un mot
	 */
	public WordInformations() {
		this.documentsNumber	= 0;
		this.frequency			= 0;
		this.beta				= 0.f;
	}

	/**
	 * Augmente la frequence du mot du nombre passe en parametre
	 * @param frequency Nombre duquel augmenter la frequence du mot
	 */
	void addFrequency(int frequency){
		this.frequency += frequency;
	}
	
	/**
	 * Augmente le nombre de documents du mot 
	 * du nombre de documents passe en parametre
	 * @param documentsNumber Nombre duquel augmenter la frequence du mot
	 */
	void addDocumentsNumber(int documentsNumber){
		this.documentsNumber += documentsNumber;
	}

	public void setBeta(double beta) {
		this.beta = beta;
	}
	
	public int getDocumentsNumber() {
		return documentsNumber;
	}

	public int getFrequency() {
		return frequency;
	}

	public double getBeta() {
		return beta;
	}
	
	
}
